home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 007a / strakd10.zip / STRAK.DOC < prev    next >
Text File  |  1995-11-18  |  8KB  |  251 lines
  1.                   StarTrak! Door Activity Tracker V1.00
  2.                   -------------------------------------
  3.  
  4. -----------------------------------------------------------------------------
  5.                               LEGAL NOTICE
  6.  
  7.                        Don't Drink And DownLoad!
  8. -----------------------------------------------------------------------------
  9.  
  10. What is it?
  11. -----------
  12.  
  13.   StarTrak is a MEX program for use with Maximus V3.00+ by Scott Dudley. The
  14. purpose of StarTrak is track the usage of the doors (or anything else you
  15. may want to track) on your BBS.
  16.  
  17.  
  18. Features:
  19. ---------
  20.  
  21.  - Easy to setup and use.
  22.  - Easy maintanence via a Sysop menu.
  23.  - Shows Last user, last date/time the door was used.
  24.  - Shows date of last counter reset.
  25.  - Easy addition\removal of door tracking data.
  26.  - Supports up to 50 Doors (default: this can be changed)
  27.  
  28. Known Shortcoming:
  29. ------------------
  30.  
  31.   Activity display is NOT sorted by the MEX program, but can be sorted using
  32. 3rd party text sorting programs. I found MEX was waaay too slow for this
  33. program as it supports up to 50 doors. If anyone has come up with a QUICK
  34. MEX sorting routine, let me know. All my attemps were quite slow.
  35.  
  36.  
  37. Files Included:
  38. ---------------
  39.  
  40.  DTRAK.MEX       | StarTrak Display Module (with Sysop menu)
  41.  STRAK.MEX       | Module that counts door entries
  42.  STRAK.CTL       | Sample control file for defining doors
  43.  STRAK.DOC       | Your reading it.
  44.  FILE_ID.DIZ     | File descriptor.
  45.  
  46. File created:
  47. -------------
  48.  
  49.  STRAK.DAT       | Data file created the first time STRAK is run.
  50.  
  51. ============================================================================
  52.  
  53. Setup:
  54. ------
  55.  
  56.   The following is a basic setup for StarTrak.
  57.  
  58.  - Either unpack the STARTRAK archive in your \max\m directory, or make a
  59.    separate directory for it (recommended).
  60.  - With your favorite Text editor, change the following in BOTH STRAK.MEX
  61.    and DTRAK.MEX to reflect your StarTrak path:
  62.  
  63. Line 22/23:
  64.  
  65. #define CONFIG       "C:\\MAX\\STRAK\\STRAK.CTL"
  66. #define DAT_FILE     "C:\\MAX\\STRAK\\STRAK.DAT"
  67.  
  68.  - Edit the following in DTRAK.MEX to specify the access level needed to
  69.    access the Sysop menu:
  70.  
  71. Line 24:
  72.  
  73. #define ACCESS       "=Sysop "
  74.  
  75.    NOTE: The space after the access level is REQUIRED! You can specify
  76.          any access you want: ">Normal ", ">=AsstSysop "
  77.  
  78.  - Compile STRAK.MEX using:      MEX STRAK
  79.  
  80.  - Compile DTRAK.MEX using:      MEX DTRAK
  81.  
  82.  - Edit STRAK.CTL as follows (see also the sample STRAK.CTL):
  83.  
  84. 1,Falcon's Eye
  85.  
  86.    The number is a reference that will be passed from MENUS.CTL (see below)
  87.    which MUST be followed by a comma. Valid numbers are 1-999. After the
  88.    comma, define the door as you wish it to appear in the StarTrak display.
  89.  
  90. 2,Barren Realms Elite
  91. 3,Solar Realms Elite
  92. 4,Lore
  93. 57,Usurper   <--- See the example below.
  94. 67,Red Dragon
  95. 77,Planets
  96. 87,Global Wars
  97. 107,Trade Wars 2002
  98. 957,Exitilus
  99.  
  100.    You can define up to 50 doors. Note that other than using numbers from
  101.    1 to 999, there is no real rhyme or reason to what numbers you use. I
  102.    use XTERN_ERLVL exits here, so I named mine according to the errorlevel
  103.    the door uses. You could just use 1 through 10 if you have 10 doors.
  104.  
  105.  - Edit MENUS.CTL as follows:
  106.  
  107. NoDsp MEX             strak\strak_57            Normal/G "5"
  108.       Display_file    misc\dorinfo              Normal/G "5 Usurper"
  109. NoDsp Xtern_Erlvl 57                            Normal/G "5"
  110.  
  111.    The first line is what we're concerned with. Notice the "strak_57"?
  112.    The "57" is the reference you set up in STRAK.CTL. (You MUST use an
  113.    underscore here, not a space)
  114.  
  115.  - Add an option in MENUS.CTL for users to view the StarTrak data as
  116.    follows:
  117.  
  118.       MEX             strak\dtrak               Twit "Activity List"
  119.  
  120.  - SILT MAX
  121.  
  122. ============================================================================
  123.  
  124.  
  125. Adding Doors:
  126. -------------
  127.  
  128.   No problem. Just make a new entry in STRAK.CTL, and make the call to
  129. the new door in MENUS.CTL. StarTrak will start the counting the first
  130. time a user enters the door.
  131.  
  132.  
  133. Removing Doors:
  134. ---------------
  135.  
  136.   Just remove the entry from STRAK.CTL and MENUS.CTL. Then select to
  137. use the Sysop Maint when displaying the activity list. Select to K)ill
  138. the door from there.
  139.  
  140.  
  141. Replacing Doors:
  142. ----------------
  143.  
  144.   If you wish to use the same number to count the new door, just change
  145. the Door name in STRAK.CTL. Then K)ill the old door in the Sysop Maint.
  146.  
  147.  
  148. Resetting a Counter:
  149. --------------------
  150.  
  151.   Select Sysop Maint when displaying the activity list. Then select to
  152. R)eset a counter. Select the door number from the list and the counter
  153. will be set to zero.
  154.  
  155.  
  156. Starting a NEW data file:
  157. -------------------------
  158.  
  159.   Select Sysop Maint, and then select to S)tart a new data file from the
  160. sysop menu.
  161.  
  162.  
  163. **If you don't want to do anything in the sysop menu, just hit "N" to
  164.   exit the maint menu.
  165.  
  166. ============================================================================
  167.  
  168. Other Considerations:
  169. ---------------------
  170.  
  171.   Although StarTrak was intended to track Door activity, you can use it
  172. with any menu option on your BBS. For instance, if you wanted to track
  173. how many people visit ....say.... your message section, and your file
  174. section, you could define the following in STRAK.CTL:
  175.  
  176. 1,Message Area
  177. 2,File Area
  178.  
  179.   Then in MENUS.CTL:
  180.  
  181. Menu MAIN
  182.  
  183.         Title           MAIN (%t Microns Remaining)
  184.         MenuFile        Menus\Main.bbs regular
  185.         MenuLength      20
  186.         % Name of cmd    Optional arguments      Priv.   Command as it
  187.         % to execute     for cmd, if any         Level   appears to user
  188.         % ------------  --------------------- --------- -----------------
  189.  
  190.   NoDsp MEX             Strak\strak_1              Twit "M"
  191.         Display_Menu    Message                    Twit "Message Areas"
  192.   NoDsp MEX             Strak\strak_2              Twit "F"
  193.         Display_Menu    File                       Twit "File Areas"
  194.         MEX             Strak\dtrak                Twit "BBS Activity"
  195.  
  196.   Hitting "B" at the main menu would then display a count of how many
  197. people visit those areas.
  198.   Again, this can be used in conjunction with any menu option.
  199.  
  200. **NOTE: NEVER try editing the STRAK.DAT files with editors which strip
  201. "white spaces" (such as QEdit) This will trash the data file. If you
  202. MUST edit the DAT files, use DOS's EDIT or any other editor which
  203. preserves "white spaces"
  204.  
  205.  
  206.   I run 30 doors here at StarLab, which are split between 3 menus
  207. (Holodecks 1-3). Each menu has its own StarTrak utility. Tracking 10
  208. doors fits nicely on a full screen. Support for a MORE prompt is
  209. built in if you are tracking more doors than will fit on a screen.
  210.  
  211.  
  212. Sorting STRAK.DAT with 3rd party Sort programs:
  213. -----------------------------------------------
  214.  
  215.   I recommend QSort by Ben Baker for this. It's fast, and needs no dump
  216. file for it's output. Just run it on the DAT file in your AFTER BBS
  217. processes as follows:
  218.  
  219.   QSORT /f77 /-21:26 STRAK1.DAT
  220.  
  221.   /f77        <--This switch defines the length of the record
  222.   /-21:26     <--This tells QSort to sort by the field at pos 21-26 in
  223.                  descending order.
  224.   STRAK1.DAT  <--Data file to be sorted.
  225.  
  226.   DOS has a SORT command, but is quite limited and needs to dump the
  227.   output to a different file. Type HELP SORT at you command line for
  228.   instruction on how to use this.
  229.  
  230.   QSort should be available to you on most BBS's (if you don't have it
  231.   on yours...shame on you! <G>) It is available for FREQ here at
  232.   1:229/732 as filename: QSORT
  233.  
  234.  
  235. Closing:
  236. --------
  237.  
  238.   Thanks for giving StarTrak a try. I hope it helps you in controlling
  239. which games are simply "space wasters".
  240.  
  241.   As I mentioned above, I would be very interested in seeing a time-
  242. sensitive sort routine in MEX which I might be able to use in a future
  243. version of StarTrak.
  244.  
  245.   You can reach me in either the MECCA/MEX echo as well as MUFFIN. Or
  246. netmail me at 1:229/732.
  247.  
  248.                                 Larry  Monte
  249.                           StarLab Systems Software
  250.                              FidoNet  1:229/732
  251.